Skip to content

Update Personal Karma help article for NewDot toggle flow#87571

Open
MelvinBot wants to merge 1 commit intomainfrom
melvin-update-personal-karma-help-article
Open

Update Personal Karma help article for NewDot toggle flow#87571
MelvinBot wants to merge 1 commit intomainfrom
melvin-update-personal-karma-help-article

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Summary

Updates the Personal Karma help site article (docs/articles/new-expensify/settings/Personal-Karma.md) to reflect the new toggle UI added in #84504.

  • Updated toggle label reference from Personal Karma to Enable Personal Karma to match exact UI text
  • Split enable/disable into separate sections for clarity
  • Documented the confirmation modal shown when disabling donations
  • Documented the payment card requirement when enabling without a billing card on file
  • Documented that billing card details are shown below the toggle when enabled

Test plan

  • Verify the article renders correctly on the help site
  • Verify all UI references (toggle label, button names) match the live product
  • Verify navigation steps are accurate

- Update toggle label reference from "Personal Karma" to "Enable Personal Karma"
- Add separate section for disabling with confirmation modal details
- Document payment card requirement when enabling
- Document billing card details display when enabled

Co-authored-by: MelvinBot <[email protected]>
@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR improves the Personal Karma article by splitting a combined enable/disable section into two dedicated task-based sections, updating the toggle label to match the current UI, and adding helpful contextual details about billing card prompts and the disable confirmation flow. The changes are well-structured and align with authoring guidelines.

Scores Summary

  • Readability: 9/10 - Steps are clear, sequential, and action-oriented. The split into separate enable/disable sections improves scannability. The added context about billing card prompts and the disable confirmation dialog is concise and useful.
  • AI Readiness: 9/10 - Both new headings follow the "How to [task]" pattern with the feature name included, which supports semantic retrieval well. The heading hierarchy uses only ## as required.
  • Style Compliance: 9/10 - Toggle label updated to Enable Personal Karma (presumably matching the current UI). Button names Disable and Cancel are correctly bolded. Step punctuation (periods) is now consistent. Minor trailing whitespace cleanup is a nice touch.

Key Findings

  • Splitting the single "How to enable or disable Personal Karma" heading into two separate sections ("How to enable Personal Karma" and "How to disable Personal Karma") is a good improvement. It makes each workflow self-contained and improves both readability and AI retrieval precision.
  • The added detail about billing card prompt behavior (dismissing reverts the toggle) and the disable confirmation flow (with Disable and Cancel options) gives users clear expectations about UI behavior, which reduces confusion.
  • The toggle label change from Personal Karma to Enable Personal Karma should be verified against the actual product UI to ensure exact match per naming conventions.
  • Note for future improvement (not part of this diff): The YAML frontmatter is missing the internalScope field required by HELP_AUTHORING_GUIDELINES.md Section 3. This pre-dates the current PR but is worth addressing in a follow-up.

Recommendations

  • Verify that Enable Personal Karma exactly matches the toggle label shown in the product UI on both web and mobile. If the UI says something slightly different (e.g., "Personal Karma" without "Enable"), the label in the article should be updated to match.
  • No blocking issues identified. The changes are ready to merge.

Files Reviewed

  • docs/articles/new-expensify/settings/Personal-Karma.md - Well-structured update splitting enable/disable into separate sections with improved step detail and UI label accuracy.


## How to disable Personal Karma

1. In the navigation tabs (on the left on Web, at the bottom on Mobile), choose **Account**.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Navigation convention: Per HELPSITE_NAMING_CONVENTIONS.md, platform labels should be lowercase in the parenthetical: "on the left on web, on the bottom on mobile" (not "Web" / "Mobile"). Also, the governance phrasing uses the verb "Click" rather than "choose":

Suggested change
1. In the navigation tabs (on the left on Web, at the bottom on Mobile), choose **Account**.
1. Click the navigation tabs (on the left on web, on the bottom on mobile), then select **Account**.

2. Select **Save the World**.
3. Toggle **Enable Personal Karma** on.

If you don't have a billing card on file, you'll be prompted to add a payment card before Personal Karma can be enabled. If you dismiss the payment card prompt without adding a card, the toggle will revert to disabled.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Terminology inconsistency: This sentence uses both "billing card" and "payment card" to refer to the same thing. Pick one term and use it consistently throughout the article. The rest of the article (and the existing intro paragraph) uses "billing card on file," so "payment card" here is inconsistent -- unless the UI prompt specifically says "payment card," in which case that should be noted explicitly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant